num-record-packer

TypeScript NUM Record Packer

This program takes a JSON object and convertes it to a more compact JSON object using a mapping specification, also written as JSON.

Running the example code in a web browser

1. Clone the repository using git clone [e-mail]:NUMtechnology/num-record-packer.git.
2. cd num-record-packer
3. Run npm install -g webpack
4. Run npm install -g webpack-cli
5. Run npm install
6. Open the test/index.html file using a web browser (Only tested using Brave browser)
7. Paste your JSON into the first two text areas and click Pack to see the result.

Use the Packer in JavaScript

const api = require('num-record-packer');

const mapperData = {
  phonetic: {
    assignKeys: ['a', 'b', 'c'],
  },
};

const data = {
  phonetic: {
    a: 'alpha',
    b: 'bravo',
    c: 'charlie',
  },
};

const packed = api.mapper.pack(data, mapperData);

console.log(JSON.stringify(packed));

Use the Packer in TypeScript

import { createNumRecordPacker } from 'num-record-packer';

const mapperData = {
  phonetic: {
    assignKeys: ['a', 'b', 'c'],
  },
};

const data: object = {
  phonetic: {
    a: 'alpha',
    b: 'bravo',
    c: 'charlie',
  },
};

const packer = createNumRecordPacker();
const packed: object = packer.pack(data, mapperData);
console.log(JSON.stringify(packed));```